package be.nepherte.movmanager.client.services;

import be.nepherte.movmanager.domain.UserInfo;
import be.nepherte.movmanager.server.UserServiceImpl;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;

/**
 * <p>
 * This class is the client side stub for user related services. The actual
 * implementation exists on the server side in {@link UserServiceImpl}. Apart
 * from a server side implementation, a client side asynchronous version,
 * {@link UserServiceAsync} is required as well. The used communication
 * protocol is Google's implementation of rpc.
 * </p>
 * 
 * <p>
 * Copyright © 2010 Bart Verhoeven
 * </p>
 * 
 * <p>
 * This file is part of MovManager.
 * </p>
 * 
 * <p>
 * MovManager is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * </p>
 * 
 * <p>
 * MovManager is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 * </p>
 * 
 * <p>
 * You should have received a copy of the GNU General Public License along with
 * MovManager. If not, see http://www.gnu.org/licenses/.
 * </p>
 * 
 * @author 	Bart Verhoeven
 * @version 0.1
 */
@RemoteServiceRelativePath("userService")
public interface UserService extends RemoteService {

	/**
	 * Retrieves the login status of the user with his/her Google account on 
	 * MovManager.
	 * 
	 * @param 	destinationURL
	 * 			where the user will be redirected after they log in or log out,
	 * 			usually the host url of MovManager
	 * @return	A user information object
	 */
	public UserInfo requestUserInfo(String destinationURL);

}